home *** CD-ROM | disk | FTP | other *** search
/ Die Speccy' 97 / Die Speccy' 97.iso / amiga_system / the_aminet / comm / net / spoolwatch.lha / SpoolWatch / SpoolWatch.doc < prev    next >
Text File  |  1995-10-02  |  6KB  |  196 lines
  1.                           SpoolWatch 2.8
  2.  
  3.                         by
  4.  
  5.     
  6.                                     Nick d'Alterio
  7.  
  8.  
  9. Preface
  10. -------
  11.  
  12. Please let me know what you think of this program, do you like it, is it 
  13. useful to you, what features would you like.
  14.  
  15. I originally started out writing it as a simple CLI program until I decided
  16. that this would be a good start for learning how to program a GUI so don't
  17. expect too much yet. This is my first proper Amiga specific program.
  18.  
  19. Introduction
  20. ------------
  21.  
  22. Have you ever wondered if your mailer has actually posted your message?
  23. Have you ever wanted to check that you had replied to that important e-mail?
  24.  
  25. Well then SpoolWatch may be the program for you.
  26.  
  27. SpoolWatch as the name implies keeps an eye on your news and mail spool
  28. directories ready to give you all the information you need about their 
  29. contents.
  30.  
  31. It can be run from the shell with either GUI or command line output, or from
  32. workbench.
  33.  
  34. Installation
  35. ------------
  36.  
  37. Just copy the executable (and icon) where you want it.
  38.  
  39. NOTE This program require 2.x
  40.  
  41. Options
  42. -------
  43.  
  44. From CLI
  45. --------
  46.  
  47. When started from CLI SpoolWatch has 7 options:-
  48.  
  49.     MAILDIR\K        Mail spool directory (AmiTCP:Usr/Spool/Mail default)
  50.  
  51.     NEWSDIR\K        News spool directory (AmiTCP:Usr/Spool/News default)
  52.  
  53.     DELAY\N            Interval at which SpoolWatch checks contents
  54.                 of spool directories. Ignore if using CLI output (10 default)
  55.  
  56.     NOGUI\S            Don't display GUI output to CLI (FALSE default)
  57.  
  58.     FULL\S            Display full information about spool to CLI,
  59.                                 ignore if not using NOGUI option(FALSE default)
  60.  
  61.     TOP\N            Top edge of window (0 default)
  62.  
  63.     LEFT\N            Left edge of window (0 default)
  64.  
  65.  
  66. examples:
  67.  
  68. > SpoolWatch NOGUI
  69.  
  70.  
  71. Mail:   0  News:   0
  72.  
  73.  
  74. > SpoolWatch NOGUI FULL
  75.  
  76.  
  77. News Spool .....
  78.  
  79.  Num  Size            Destination                 Time Queued
  80.  
  81.   1   4238  rec.games.netrek                    52 days 15 h 48 m
  82.   2   4238  rec.games.netrek                    52 days 15 h 48 m
  83.   3   4238  rec.games.netrek                    52 days 15 h 48 m
  84.   4   4238  rec.games.netrek                    52 days 15 h 48 m
  85.  
  86.  Press return to continue...
  87.  
  88.  
  89.  
  90.  Mail spool is empty
  91.  
  92. From Workbench
  93. --------------
  94.  
  95. The options are specified by TOOLTYPES:-
  96.  
  97.     MAILDIR            Location of mail spool directory (AmiTCP:Usr/Spool/Mail default)
  98.  
  99.     NEWSDIR            Location of news spool directory (AmiTCP:Usr/Spool/News default)
  100.  
  101.     LEFT            Left edge of window (0 default)
  102.  
  103.     TOP            Top edge of window (0 default)
  104.  
  105.     DELAY             Interval, in seconds, at which SpoolWatch
  106.                 looks at spool directories (10 default)
  107.  
  108. The GUI
  109. -------
  110.  
  111. Initially when started the GUI will be a title-bar sized window containing a
  112. brief summary of the number of files in each spool. 
  113.  
  114. Clicking the Right Mouse in the window will toggle between the full display 
  115. and the title-bar window unless both spools are empty in which case the window
  116. will remain title-bar sized.
  117.  
  118. The full display window has one gadget which toggles between a display of
  119. the news spool directory and the mail spool directory. If either of the 
  120. spool directories is empty the gadget will do nothing.
  121.  
  122. The full display window will grow automatically as the number of messages
  123. in the spool directory increases. However at the moment once the window
  124. has reached the maximum height allowed by the screen all subsequent messages
  125. will be ignored and a requester displayed telling you of this (in actual
  126. use this has never happened for me since I never have 48 messages waiting
  127. to be sent)
  128.  
  129. SpoolWatch uses the default window font for the text.
  130.  
  131. To quit the program press the Close gadget or send a CTRL-C. The program will
  132. not exit immediately but will wait until the current timer cycle is
  133. finished and then exit.
  134.  
  135. Compatibility and Notes
  136. -----------------------
  137.  
  138. This program should work equally well no matter which networking system
  139. you use just so long as there are separate spool directories and the 
  140. mail header contains a line beginning with To: and the news header
  141. contains a line beginning with Newsgroups:
  142.  
  143. On my AmiTCP setup with INet Util 1.4 I have never encountered a news/mail
  144. file it hasn't been able to handle.
  145.  
  146. NOTE: If there are are multiple destinations only the first will be displayed,
  147. also the maximum length of name that will be displayed is 35 characters.
  148.  
  149. If your off-line news or mail writing program produces multiple files 
  150. e.g SMTPPost produces D.54543353 and X.32454643
  151. SpoolWatch can handle counting only the actual messages so long as these
  152. supporting files do not contain the lines Newsgroups: or To:
  153.  
  154. Future
  155. ------
  156.  
  157. If there is enough interest in this program I will probably implement
  158. at least some of the following.
  159.  
  160.     Improved GUI
  161.     Listview for the messages
  162.     Ability to edit, delete, send spooled messages
  163.  
  164. Send me any other suggestions.
  165.  
  166. Distribution
  167. ------------
  168.  
  169. This program is free distributable. If a PD company wants to distribute it
  170. they MUST charge a reasonable price i.e. not more than 50p + disk price
  171. (are you reading this PD-Soft!)
  172.  
  173. I accept NO liability for incidents resulting from the use of this program.
  174.  
  175. Bugs
  176. ----
  177.  
  178. There are currently no known bugs, if you find one please let me know
  179.  
  180.                        daltern@ic.ac.uk
  181.  
  182. History
  183. -------
  184.  
  185. 2.8        BUGFIX: If the system font was non proportional then the
  186.              titlebar window opened was too small for the text.
  187.  
  188. 2.7        BUGFIX: Some last minute error checking code caused memory
  189.                         to be freed twice.
  190.  
  191. 2.6         First public release
  192.  
  193. -------------------------------------------------------------------------------------------
  194. Nick d'Alterio (daltern@ic.ac.uk)
  195.  
  196. $Id: SpoolWatch.doc 1.3 1995/10/02 22:39:48 daltern Exp $